home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / clipper / ks94an.zip / CHECKNTX.HDR < prev    next >
Text File  |  1994-04-25  |  1KB  |  48 lines
  1. /******************************************************************************
  2.                  The Klipper Library, for CA-Clipper 5.x
  3.         Copyright (c), 1994, Wallace Information Systems Engineering
  4.  
  5. FUNCTION:
  6.  
  7. _CheckIndex(cDName, cNName, cKey ) --> NIL
  8.  
  9. PARAMETERS:
  10.  
  11. cDname : Database File Name
  12. cIname : Index File Name
  13. cKey   : Index Key
  14.  
  15. SHORT:
  16.  
  17. Check and, if missing, build an index file.
  18.  
  19. DESCRIPTION:
  20.  
  21. _CheckIndex() allows a quick, or in-line check of an index file and builds
  22. it according to parameter information if it does not exist.
  23.  
  24. Note: This function assumes NOTHING.  You must make sure that the
  25. database file exists, and that the index key is valid for the
  26. specified database.
  27.  
  28.  
  29. The database specified in cDName must not be open in any work area.
  30. For obvious reasons, the function cannot open the database exclusively
  31. in order to build the index if it is open elsewhere.
  32.  
  33. Thus, you should call this function before opening your databases.
  34. Regardless, this function returns NIL.
  35.  
  36. NOTE:
  37.  
  38.  
  39.  
  40. EXAMPLE:
  41.  
  42. _CheckIndex('BUDGET.DBF','BUDGETACC.NTX','Budget->Account_Num')
  43.  
  44. If BUDGET.NTX does not exist, BUDGET.DBF is opened exclusively and indexed on
  45. Budget->ACCOUNT_NUM.
  46.  
  47. ******************************************************************************/
  48.